GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
propertyTypeId |
Id of the property type |
globally unique identifier |
None. |
take |
Number of properties to retrieve. Default is all properties |
integer |
None. |
skip |
Number of properties to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the properties before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of properties.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "PropertyId": "e4d2e1ff-ceaa-41f0-b2a6-61cb409eb642", "Asset": { "AssetId": "51b7ba67-0d41-46c7-b9f9-069fc14b791f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a8d5fd34-7017-46ad-893a-ed4223c9c3d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3e0d7eaf-6347-4101-8285-eab139002b8a", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "5de53bdd-1cdf-4428-bf44-87330b76c342", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "MeasurementValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bded5f64-a53f-4809-803f-2435b7063fae", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "MeasurementValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ab4a9d36-8756-4f4a-96b0-618f437b68af", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "11a75c5a-c331-4137-bae0-8df6eb76fa74", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a8d5fd34-7017-46ad-893a-ed4223c9c3d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3e0d7eaf-6347-4101-8285-eab139002b8a", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "0be75d23-16eb-421c-a74c-7188c87cefb5", "Name": "sample string 1" }, "Unit": { "UnitId": "75cfe9d1-4559-479b-90c6-9887e2869f55", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f49b1650-c7fc-4e87-8c32-4adb2946b16e", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "5d986e5f-82b4-491e-9982-5053fbfeca4d", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0d6a7837-5e93-4d62-bcd9-aa2a07d13173", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, { "PropertyId": "e4d2e1ff-ceaa-41f0-b2a6-61cb409eb642", "Asset": { "AssetId": "51b7ba67-0d41-46c7-b9f9-069fc14b791f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a8d5fd34-7017-46ad-893a-ed4223c9c3d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3e0d7eaf-6347-4101-8285-eab139002b8a", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "5de53bdd-1cdf-4428-bf44-87330b76c342", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "MeasurementValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bded5f64-a53f-4809-803f-2435b7063fae", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "MeasurementValueNeededDate": "2024-05-01T16:43:51.1910971-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ab4a9d36-8756-4f4a-96b0-618f437b68af", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "11a75c5a-c331-4137-bae0-8df6eb76fa74", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a8d5fd34-7017-46ad-893a-ed4223c9c3d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3e0d7eaf-6347-4101-8285-eab139002b8a", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, "DataType": { "DataTypeId": "0be75d23-16eb-421c-a74c-7188c87cefb5", "Name": "sample string 1" }, "Unit": { "UnitId": "75cfe9d1-4559-479b-90c6-9887e2869f55", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f49b1650-c7fc-4e87-8c32-4adb2946b16e", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "5d986e5f-82b4-491e-9982-5053fbfeca4d", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0d6a7837-5e93-4d62-bcd9-aa2a07d13173", "CreateDate": "2024-05-01T16:43:51.1910971-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-01T16:43:51.1910971-07:00", "LastModifiedUser": "sample string 7" } ], "Total": 1, "Message": "sample string 1" }